﻿/****************************************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (http://rapidwebdev.org)
	Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@RapidWebDev.org

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ****************************************************************************************************/

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace BaoJianSoft.ExtensionModel.Statistic
{
	/// <summary>
	/// Api to analyze statistic report and management analyzing fields.
	/// </summary>
	public interface IStatisticApi
	{
		/// <summary>
		/// Create statistic report for data source by specified definition.
		/// </summary>
		/// <param name="statisticDefinition"></param>
		/// <param name="dataSource"></param>
		/// <returns></returns>
		IEnumerable CreateStatisticReport(StatisticDefinition statisticDefinition, IList dataSource);

		/// <summary>
		/// Resolve all candidate statistic properties by name.
		/// </summary>
		/// <param name="candidateStatisticPropertyCollectionName"></param>
		/// <returns></returns>
		IEnumerable<CandidateStatisticProperty> ResolveAllCandidateStatisticProperties(string candidateStatisticPropertyCollectionName);

		/// <summary>
		/// Resolve all candidate statistic properties by configuration name union with extension properties of specified extension type.
		/// </summary>
		/// <param name="candidateStatisticPropertyCollectionName"></param>
		/// <param name="extensionTypeIds"></param>
		/// <returns></returns>
		IEnumerable<CandidateStatisticProperty> ResolveAllCandidateStatisticProperties(string candidateStatisticPropertyCollectionName, IEnumerable<Guid> extensionTypeIds);

		/// <summary>
		/// Transform candidate statistic property to statistic filter.
		/// </summary>
		/// <param name="candidateStatisticProperty">candidate statistic property</param>
		/// <param name="headerText">statistic filter header text</param>
		/// <param name="ordinal">statistic filter ordinal</param>
		/// <returns></returns>
		StatisticFilter TransformToStatisticFilter(CandidateStatisticProperty candidateStatisticProperty, string headerText, int ordinal);
	}
}
